Interface UserAuthenticationCallback
public interface UserAuthenticationCallback
The
UserAuthenticationCallback interface defines the specific elements required for the
integrator to interact with during a User Authentication flow.
If the integrator uses a custom user authentication, this interface will be called during any flow where a User Authentication is needed.
A UserAuthenticationCallback object should be provided to the Orchestrator object (See Orchestrator.setUserAuthenticationCallback(UserAuthenticationCallback, UserAuthentication[])) in order to receive feedback during the user password authentication
process.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enumUser authentication type that can be customized by the integrator -
Method Summary
Modifier and TypeMethodDescriptionvoidCalled upon user input error when it is not conform for the Orchestration library.voidonUserAuthenticationRequired(UserAuthenticationCallback.UserAuthentication type, UserAuthenticationInputCallback inputCallback, boolean isEnrollment) Called when a specific user authentication has been overridden and if a user authentication is required by the Orchestration library.
-
Method Details
-
onUserAuthenticationRequired
void onUserAuthenticationRequired(UserAuthenticationCallback.UserAuthentication type, UserAuthenticationInputCallback inputCallback, boolean isEnrollment) Called when a specific user authentication has been overridden and if a user authentication is required by the Orchestration library. An authentication should be presented to the user. And the user input should be returned through the inputCallback.- Parameters:
type-UserAuthenticationCallback.UserAuthenticationthe type of authentication asked by the Orchestration libraryinputCallback- aUserAuthenticationInputCallbackcallback to give the user input to the Orchestration libraryisEnrollment- is set to true in case of enrollment
-
onUserAuthenticationInputError
Called upon user input error when it is not conform for the Orchestration library.- Parameters:
error- the type of input error
-